Audit Trail Logs

Purpose

Audit Trail Logs provide a historical record of changes made to the system from the System Administration Tool and various other user interfaces and applications. It does this by recording certain actions (such as who logged in and when) and storing this information in a log. Use the logs to help with troubleshooting when problems arise and to determine who in a multi-administrator system is responsible for a particular change. The following is a list of the features supported by the Audit Trail facility:

Audited User Interfaces and Applications

The user interfaces and applications audited for database changes and logins/logouts are as follows:

Audited Actions

The following operations are logged:

The following are excluded from Audit Trail logs:

NOTES

 

Login/Logout Types Audited

The following login and logout types are logged

Example Login/Logout Log

ID

Time Stamp

Username

Source IP

App Name

App Context

Action Type

Action Data

98

2010-03-21 09:45:37

System

10.1.1.10

System Admin Tool

User Session

Login

Session ID: 10

User Authenticated: True

Session Availability: True

99

2010-03-21 09:45:37

System

10.1.1.10

System Admin Tool

User Session

Logout

Session ID: 10

Comments: Terminated by timeout

100

2010-03-21 09:45:37

System

10.1.1.10

Software Installer

MiXML-SS

Login

Session ID: 11

User Authenticated: True

Session Availability: True

Comments: Cert=#349

101

2010-03-21 09:45:37

System

10.1.1.10

Software Installer

MiXML-SS

Logout

Session ID: 11

Comments: Application Requested Logout

Action Data

Information logged with each login/logout is as follows:

User Authenticated—either True if the login was successful or False if not.  Note that successful login indicates that the administrator entered the password correctly. It does not mean that the administrator was able to access the system, because all of the available sessions may be in use (see Session Availability below).

Session Availability—either True if a session is available for an administrator who has entered a valid user name and password or False: Login session is not available and the administrator, even if validated, cannot access the system. For example, an administrator can successfully login with the correct user name and password but fail to get access if the maximum number of sessions allowed for the selected tool has already been reached.

Session ID—The number of administrators that can access a particular system tool is limited by the maximum number of sessions supported by that tool:

The Session ID numbers are only unique for the same type of system access. Therefore, you must use both the login type and the session ID to identify login and logout events from the same session or administrator.

Log File Size and Location

The Audit Trail logs are stored in the system database in a circular buffer format and in an XML file located in the /db/database/audit_trail/ directory. The name of the XML file is derived from the hostname of the controller as specified in the System IP Properties form and the date/time of is creation—for example, localhost_20100505192045.xml.

The log can hold a maximum of 5000 records. When the maximum is reached, the next record logged (#5001) replaces the oldest (#5000) in the form, while at the same time a new XML file with the same name but a later timestamp is started.

Field Descriptions

Parameter

Description

ID

A unique identification number assigned to the log.

Date

Date of the login or logout event. The format is <yyyy, mmm, dd>

Time

Time of the login or logout event. The time is the local time of the controller that posted the log. The format is <hh:mm:ss>.

Detail Level

The amount of detail in the logged action. Fixed at 'Low' for this release.

User Name

User name of the account that performed the logged action (if applicable).

Source IP

IP Address (IPv4 or IPv6) of the client station that the user or application is connecting from. For System Administration Tool access, this is the IP address of the PC that the web browser is running on. For Admin Group Reach-Through, it's the IP address of the Login Node that initiated the Reach Through. For internal applications, the Source IP is the System IP address of the controller as configured in the System IP Properties form.

App Name

Name of the application that performed the logged action. Examples: System Admin Tool, Software Installer, Config Wizard, Prairie Fyre App, GDC Client.

NOTE: GDC (Generic Data Client) refers to applications that are not readily identifiable.

App Context

Context or area of the application where the change was made. Examples: PMS, IDS Data Management, Maintenance Command Handler, Backup Selected Node, Restore.

Action Type

Type of action that was performed by the user or application. For user-triggered actions, the action type usually reflects the label of the UI button that was used to initiate the change—for example: Add, Change, Save, Submit, etc. Actions triggered by applications are similarly labeled.

Action Data

The logged data. In some cases this field may contain a lot of information, for example, when many Add’s are performed using a single action such as an Import.

Examples:

  1. Action Data logged as a result of changes to the System Options form:

--OLD—
Music On Hold: No
Battery Backup: No

--NEW—
Music On Hold: Yes
Battery Backup: Yes

  1. Action Data logged as a result of deleting a user from the User and Service Configuration form:

--KEY—
Number: 1111
Directory Name: Lee,Bob

--OLD--
Last Name: Lee
First Name: Bob
User Profile Login ID: LeeB
Desktop Admin: True
Device Id: 1
Device Type: 5603 SIP
Line Type: 1
Language: 1

  1. Action Data logged as a result of a login from an external MiXML application (in this case the Software Installer):

Session ID: 11
User Authenticated: True
Session Availability: True
Comments: Cert=#349